Skip to content

feat: sync new SDK APIs from openapi to docs site#962

Open
endless-bot wants to merge 41 commits into
mainfrom
endless/task-11
Open

feat: sync new SDK APIs from openapi to docs site#962
endless-bot wants to merge 41 commits into
mainfrom
endless/task-11

Conversation

@endless-bot
Copy link
Copy Markdown
Collaborator

@endless-bot endless-bot commented May 8, 2026

Summary

Syncs new SDK interfaces introduced in openapi to the developers documentation site, along with a range of docs, UI, and infrastructure improvements.

New API Documentation (EN / zh-CN / zh-HK)

Quote APIs

  • option_volume — option volume query
  • option_volume_daily — daily option volume query
  • short_positions — short position data
  • update_pinned — update pinned securities

Fundamental APIs

  • Calendar: dividend, earnings, IPO, macro, split calendars
  • Fundamental: company profile, corporate actions, dividends, executives, financial reports, fund holdings, ratings, shareholders, valuations
  • Market: AH premium, broker positions, index components, market status, trading stats, unusual items

Account APIs

  • Alert: create, delete, list, update alerts
  • DCA (dollar-cost averaging): create, delete, list, update, history
  • Portfolio: capital flow, exchange rates, profit analysis (by market, detail, summary)
  • Sharelist: create, delete, list, update share lists

UI / Site Improvements

  • Pricing page: new tri-locale pricing comparison page for market data subscription tiers; fixes for responsive layout and static QR code on mobile
  • FeaturesMenu: mega-menu dropdown in main nav with 9 financial data product categories; full i18n support
  • Nav: moved API Reference from top nav to Docs sidebar (opens in new tab)
  • Homepage visual polish: neutral color vars on ArchCanvas, distinct card accent hues, section border delineation, ProductSkill gradient, flat GetStarted background
  • Quote permission: added permission notices across CLI docs, API docs, and API Reference; removed unreliable client-side permission status detection
  • Mock login toggle: dev-only panel to simulate login/logout state; shared reactive useLoginState composable

Docs Updates

  • CLI v0.19.2 release notes + updated finance-calendar subcommand examples
  • Corrected quote permission names to match Quote Store (pluralization, Nasdaq Basic rename)
  • Updated skill guide to use CLI-first flow
  • Fixed missing zh-HK translations

Bug Fixes

  • Fixed UnoCSS build error from arbitrary font-feature-settings class
  • Added result.root null guard in postcss.config.mjs to prevent PostCSS crash
  • Fixed home page footer rendering
  • Fixed pricing page build dist

🤖 Auto-generated by Endless.

@hogan-yuan hogan-yuan marked this pull request as draft May 8, 2026 07:53
@hogan-yuan hogan-yuan changed the title feat: sync new SDK APIs from openapi commit 523035611 to docs site feat: sync new SDK APIs from openapi to docs site May 10, 2026
endless-bot and others added 25 commits May 13, 2026 22:03
# 任务:将 openapi commit 523035611 新增的 SDK 接口同步到 developers 文档站

你的任务是将 openapi 仓库 commit `523035611c81

🤖 Generated with Endless

Co-authored-by: 老袁 Yuan Zhanghong <zhanghong.yuan@longbridge-inc.com>
# 任务:将 openapi commit 523035611 新增的 SDK 接口同步到 developers 文档站

你的任务是将 openapi 仓库 commit `523035611c81

🤖 Generated with Endless

Co-authored-by: 老袁 Yuan Zhanghong <zhanghong.yuan@longbridge-inc.com>
- Fix CalendarContext: unify 5 calendar pages to use finance_calendar SDK
  method with CalendarCategory enum; fix HTTP URL to /v1/quote/finance_calendar
- Add Meeting and Merge calendar pages
- Fix PortfolioContext: rename capital_flow → profit_analysis_flows
- Add 11 missing FundamentalContext methods (institution_rating,
  institution_rating_detail, dividend_detail, forecast_eps, consensus,
  valuation_history, industry_valuation, industry_valuation_dist,
  invest_relation, operating, buyback)
- Add 3 missing MarketContext methods (broker_holding_detail,
  broker_holding_daily, ah_premium_intraday)
- Add 2 missing AlertContext methods (enable, disable)
- Add 7 missing DCAContext methods (pause, resume, stop, stats,
  check_support, calc_date, set_reminder)
- Add 5 missing SharelistContext methods (detail, popular,
  add_securities, remove_securities, sort_securities)
- Add icons and collapse subdirectories for Fundamental and Account sections
- Add Overview pages for Fundamental and Account sections
- Translate zh-CN/zh-HK SDK docs; remove duplicate CLI tabs

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Add srcExclude for superpowers/** (fixes Vue parse error in local files)
- Add buildConcurrency: 10 and manualChunks to reduce build memory
- Add mark.js to ssr.noExternal to fix Tailwind v4 ESM loader conflict
- Add GC plugin (fire global.gc() between client/server bundles)
- Add --expose-gc to CI workflow NODE_OPTIONS for GC plugin to work
- Fix skill install URL/package name: developers.longbridge.com →
  open.longbridge.com, longbridge/developers → longbridge/skills

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
document is not available during SSR; move dark-mode color detection
into onMounted so it only runs in the browser.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Replace all _rsp schema names with PascalCase Response (492 changes)
- Fix company_profile: expand to 32 actual fields from API response
- Fix shareholders: use shareholder_list + total structure, add ShareholderItem
- Fix institution_rating: nested analyst + instratings structure
- Fix executives: professional_list → ExecutiveGroup + Executive
- Fix market_status: actual {market, status} list structure
- Fix index_components: rise_num/fall_num/flat_num + ConstituentStock fields
- Fix list_dca: all 20 DcaPlan fields from live API
- Remove non-existent CLI commands from ratings.md and buyback.md

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
All response schemas now verified against actual SDK Python calls:

FundamentalContext:
- company_profile: phone (lowercase), sector (integer)
- institution_rating: latest/summary structure (was analyst/instratings)
- ratings: StockRatings fields (multi_score, multi_letter, etc.)
- fund_holdings: FundHolders.lists with symbol/code/position_ratio
- buyback: 3 nested types (history/ratios/recent_buybacks)

MarketContext:
- market_status: market_time list with delay fields
- broker_positions: BrokerHoldingTop buy/sell/updated_at structure
- index_components: symbol (not counter_id), no total field
- unusual_items: AnomalyResponse all_off/changes
- trading_stats: statistics object + trades price-level list

CalendarContext:
- All 5 calendar docs: unified CalendarEventsResponse/DateGroup/EventInfo

AccountContext:
- list_alerts: AlertList.lists with AlertSymbolGroup + AlertItem
- list_dca: DcaList.plans (not list), added aaid/account_channel
- check_support: DcaSupportList.infos with support_regular_saving
- exchange_rates: ExchangeRates.exchanges with bid/offer/average rates
- list_sharelist/popular: SharelistList fields
- profit_analysis_summary: ProfitAnalysis sublist structure

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- financial_report: params kind/period use enum types not strings
  (IncomeStatement/Annual etc.), schema updated to actual nested
  FinancialReportIndicator/Account/Value structure
- profit_analysis_detail: fix param names (start/end not start_date/
  end_date), add symbol as required, fix schema to ProfitAnalysisDetail
  with underlying_details + derivative_pnl_details (ProfitDetails type)

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- operating: expand OperatingList → OperatingItem → OperatingFinancial
  → OperatingIndicator (was empty list at runtime)
- unusual_items: add AnomalyItem sub-schema to changes[] field
- list_sharelist/popular_sharelist: expand SharelistInfo + SharelistStock
- dca_stats: add nearest_plans field with cross-ref to DcaPlan

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- broker_holding_daily: BrokerHoldingDailyHistory with list[DailyItem]
- dca_history: DcaHistoryResponse with records[] + has_more
- profit_analysis_flows: ProfitAnalysisFlows with flows_list[] + has_more,
  FlowItem fields from .pyi (direction/executed_*/describe)
- profit_analysis_detail: add updated_at + updated_date fields
- Update sdk_call_results.md with all 48 interface results

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…l schema

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
AlertContext: add/delete=None(void); enable/disable=None(void) [API err on test data]
SharelistContext: create=None(void on mock), detail=SharelistDetail{sharelist,scopes},
  add/remove/sort/delete securities=None(void)
sharelist_detail schema: expanded with SharelistInfo+SharelistScopes nested types
unusual_items.changes, profit_analysis_flows.flows_list remain empty (no data)
Update sdk_call_results.md with full 48-interface result table

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…esults

- disable/enable: SDK bug (missing frequency field); API returns {id,status}
  verified via CLI; documented expected response structure
- delete_dca: clarified as stop() which permanently ends plan, returns None
- sdk_call_results.md: add row numbers, show first field only

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Delete separate enable_alert.md and disable_alert.md (3 locales each)
- update_alert.md now covers both operations with correct SDK usage:
  first call list() to get AlertItem, then pass to enable(item)/disable(item)
- Fix SDKLinks method from update_alert to enable
- Update CLI examples and all language code samples

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- SharelistStock: add missing latency and unread_change_log_category fields
  (confirmed from popular_sharelist detail response with actual data)
- unusual_items.changes, profit_analysis_flows.flows_list remain empty
  (no market anomalies, no account flow data) — schemas validated from .pyi

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Reorder top-level sections: Fundamental (3.5) → News & Contents (4) → Trade (4.5)
- Rename Community → News & Contents (zh: 资讯与社区); Socket Feed → Appendix (zh: 附录)
- Reorganize News & Contents: add news/, topics/, sharelist/ subdirectories
- Move Sharelist from Account into News & Contents
- Rename Quote/Individual → Watchlist (zh: 自选股)
- Clean up page titles: remove Get/List/Retrieve prefixes from read-operation pages (EN + zh-CN + zh-HK)
- Q&A → Q & A

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add 26 missing CLI subcommand → doc page mappings in cli-command.ts
- Update docs/index.md overview: list all current sections (Quote, Fundamental,
  News & Contents, Trade, Account, CLI, MCP) and add /pricing link

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@huacnlee huacnlee marked this pull request as ready for review May 13, 2026 14:19
huacnlee and others added 15 commits May 13, 2026 22:31
…schemas

Both ExecutiveGroup and DcaPlan return `symbol` (not `counter_id`),
confirmed from live Python SDK calls.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…list_dca

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Verified via live Python SDK calls: all three interfaces return `symbol`
(e.g. "AAPL.US") not `counter_id` (e.g. "ST/US/AAPL") format.

Files: executives.md, index_components.md, list_dca.md (en/zh-CN/zh-HK)

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Replace all auto-generated/placeholder Response Examples with accurate
JSON based on actual Python SDK responses. Fix field name mismatches
between Examples and Schemas across 41 interface doc pages (123 files,
en/zh-CN/zh-HK).

Key fixes:
- company_profile: ceo/description → manager/profile, add real fields
- shareholders: name/percentage/type → shareholder_name/percent_of_shares/institution_type
- fund_holdings: fund_name/percentage → name/position_ratio, add symbol/code
- executives: add professional_list/professionals structure
- corporate_actions: align date/description/ratio to act_desc/act_type/action
- dividends/dividend_detail: align to id/symbol/ex_date/payment_date/record_date/desc
- buyback: add 3-object structure (history/ratios/recent_buybacks)
- ratings: align to multi_letter/multi_score/industry_name etc
- institution_rating: analyst/instratings → latest/summary (Schema + Example)
- forecast_eps: align items[] fields to SDK
- consensus: add currency/current_index/list[]/details[] structure
- valuation_history: add history.metrics.pe/pb/ps structure
- industry_valuation/dist: align field names
- invest_relation: add forward_url/invest_securities[]/symbol
- operating: add full OperatingItem/Financial/Indicator structure
- financial_report: add nested dict[kind→indicators→accounts→values] structure
- market_status: status → market_time[] with delay_* fields
- broker_positions: broker_id/buy_qty → parti_number/chg/buy[]/sell[]
- broker_holding_detail: align to list[]/updated_at
- ah_premium/intraday: align klines[] fields
- trading_stats: add statistics+trades structure
- unusual_items: alert/time → all_off/changes[AnomalyItem]
- index_components: align stocks[] to symbol/chg/amount/inflow etc
- Calendar (5): replace old simplified format with CalendarEventsResponse structure
- exchange_rates: pair → base_currency/other_currency/bid_rate/offer_rate
- profit_analysis_summary: add summary/sublist full structure
- profit_analysis_by_market: align to has_more/profit/stock_items[]
- profit_analysis_detail: add underlying/derivative ProfitDetails structure
- profit_analysis_flows: add flows_list[FlowItem] with correct fields
- list_alerts: add lists[AlertSymbolGroup]/indicators[AlertItem] structure
- list_dca: add plans[DcaPlan] with symbol/stock_name/invest_frequency etc
- dca_history: add records[DcaHistoryRecord] with correct fields
- dca_stats: add nearest_plans[] to Example
- check_support: support → support_regular_saving

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…emas

A. broker_holding_daily: Example was completely wrong (had broker_id/
   broker_name/history structure). SDK returns {list:[{chg,date,holding,
   ratio}]}. Fixed Example and Schema.

B. broker_holding_detail: ratio and shares fields are nested objects
   {value,chg_1,chg_5,chg_20,chg_60}, not plain strings. Updated
   Example and Schema to show nested structure.

Verified via live Python SDK calls.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
4. dca_stats: nearest_plans[] now shows full DcaPlan fields (symbol,
   stock_name, market, status, per_invest_amount, invest_frequency,
   invest_day_of_month, next_trd_date, cum_amount, cum_profit)

5. list_alerts: AlertItem indicators[] now fully documented with
   id/indicator_id/enabled/frequency/scope/state/text/value_map fields

6. profit_analysis_summary: Added profits.* breakdown fields (stock/
   crypto/fund/ipo/mmf/other/cumulative_transaction_amount) and full
   ProfitAnalysisItem fields in sublist.items[] including isin,
   security_code, derivatives_profit, order_profit, updated_at/date

12. shareholders: Added forward_url field to ShareholderList schema

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…olGroup/AlertItem schemas

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
All object[] fields in Schema tables now link to their corresponding
child schema definition, e.g.:
  | list | object[] | true | Calendar date groups, see [CalendarDateGroup](#CalendarDateGroup) |

Covers 40 doc pages × 3 locales = 103 files updated across:
- Calendar (5 docs): list→CalendarDateGroup, infos→CalendarEventInfo
- Fundamental (15 docs): executives, shareholders, buyback, consensus,
  dividends, financial_report, fund_holdings, operating, etc.
- Market (9 docs): broker positions/detail/daily, index_components, etc.
- Account (8 docs): alerts, DCA, portfolio, exchange_rates, etc.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…lding_detail

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
22 doc pages with 1-level nesting now use the ∟ prefix style
(matching existing quote/trade docs style) instead of separate
child schema tables.

Converted (en/zh-CN/zh-HK):
Fundamental:
- corporate_actions: CorpActionItem inline
- dividend_detail / dividends: DividendItem inline
- forecast_eps: ForecastEpsItem inline
- fund_holdings: FundHolder inline
- industry_valuation / industry_valuation_dist: ValuationDist inline
- invest_relation: InvestSecurity inline
- shareholders: ShareholderItem inline
Market:
- ah_premium / ah_premium_intraday: klines item inline
- broker_holding_daily: BrokerHoldingDailyItem inline
- broker_positions: BrokerHoldingEntry inline
- index_components: ConstituentStock inline
- market_status: MarketTimeItem inline
- trading_stats: TradePriceLevel inline
- unusual_items: AnomalyItem inline
Account:
- exchange_rates: ExchangeRate inline
- profit_analysis_by_market: StockProfitItem inline
- profit_analysis_flows: FlowItem inline
- check_support: DcaSupportInfo inline
- dca_history: DcaHistoryRecord inline

Kept as separate tables (3+ levels or complex nesting):
calendar docs, executives, operating, consensus, financial_report,
institution_rating, institution_rating_detail, buyback,
profit_analysis_summary/detail, list_alerts, list_dca,
broker_holding_detail, valuation_history

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants